v3.0.1

Compare Source

v3.0.0

Compare Source

v2.8.15

Compare Source

Added

• #​3122 – Add log notifications when SpringDocs / Scalar are enabled by default
• #​3123 – Add support for serving static resources
• #​3151 – Add @Order to ApplicationReadyEvent listener
• #​3158 – Add support for API groups in Scalar
• #​3187 – Add Scalar WebMVC and WebFlux support
• #​3185 – Disable creation of blank GitHub issues (GitHub settings & workflow)
• #​3186 – Decouple Web Server APIs following Spring Boot modularization
• #​3131 - Improve warning messages when documentation is explicitly enabled
• #​3183 - Remove unused operations consumer from route builder methods
• #​3141 - Change handling so useReturnTypeSchema is evaluated at HTTP status code level instead of method level

Changed

• Upgrade Spring Boot to version 3.5.9
• Upgrade swagger-core to version 2.2.41
• Upgrade swagger-ui to version 5.31.0
• Upgrade Scalar to version 0.4.3

Fixed

• #​3133 – Fix regression where content type from Swagger @RequestBody did not take precedence
• #​3146 – Fix WebJar resource handler mappings for Swagger UI resources
• #​3168 – Support @Schema annotations on Kotlin value classes
• #​3178 – Fix regression when generating documentation for Kotlin LinkedHashSet
• #​3170 – Fix warnings when setting title and description in application.yml
• #​3187 – Add scalar scalar-webmvc and scalar-webflux support

v2.8.14

Compare Source

Added

• #​3090 - Add logs to notify when SpringDocs/Scalar is enabled because SpringDocs/Scalar is enabled by default

Changed

• Upgrade swagger-ui to v5.30.1
• Upgrade swagger-core to v2.2.38
• Upgrade spring-boot to v3.5.7
• Upgrade commons-lang3 to v3.18.0
• Upgrade scalar to v0.3.12

Fixed

• #​3107 - Fix:compatible with lower version of getOpenApi().
• #​3121 - NPE in KotlinDeprecatedPropertyCustomizer - resolvedSchema is null

v2.8.13

Compare Source

Added

• #​3084 - Add Scalar Support

Changed

• Upgrade swagger-ui to v5.28.1

Fixed

• #​3076 - With oneOf the response schema contains an extra type: string

v2.8.12

Compare Source

Changed

• Upgrade swagger-ui to v5.28.0

Fixed

• #​3073 - Duplicate key class Parameter when documenting two GET methods with same path and PathVariable.
• #​3071 - @​io.swagger.v3.oas.annotations.parameters.RequestBody does not work well with @​RequestPart
• #​3066 - Parameter is now required after upgrading to springdoc-openapi 2.8.10

v2.8.11

Compare Source

Added

• #​3065 - javadoc and overall performance optimization

Changed

• Upgrade spring-boot to v3.5.5

Fixed

• #​3064 -ClassNotFoundException: kotlin.reflect.full.KClasses

v2.8.10

Compare Source

Added

• #​3046 - Feature Request: Support @​jakarta.annotation.Nonnull.
• #​3042 - Support externalDocs configure on SpecPropertiesCustomizer
• #​3057 - Refactor webhook discovery and scanning mechanism

Changed

• Upgrade spring-boot to v3.5.4
• Upgrade swagger-ui to v5.27.1
• Upgrade swagger-core to 2.2.36

Fixed

• #​3050 - @​RequestPart JSON parameters missing Content-Type in generated curl commands, causing 415 errors.
• #​2978 - Parameter is no longer optional after upgrade to 2.8.8
• #​3022 - NullPointerException thrown in SchemaUtils.
• #​3026 - Fix unexpected merging of media types
• #​3036 - Fixed "desciption"
• #​3039 - Fix: Property resolution for extensions within @​OpenAPIDefinition Info object
• #​3051 - Fixes so that a RequestPart with a Map is added to the RequestBody
• #​3060 - Use adaptFromForwardedHeaders instead of deprecated fromHttpRequest

v2.8.9

Compare Source

Added

• #​2944 - Support for @​Positive
• #​3011 - type-use for method parameters

Changed

• Upgrade spring-boot to version 3.5.0

Fixed

• #​2982 - application/problem+json content type is not set for ProblemDetails
• #​2990 - Issues with POST Request, application/x-www-form-urlencoded and only one parameter
• #​2998 - io.swagger.v3.oas.annotations.Webhook does not work when defined on the method level
• #​3012 - Order of examples is (sometimes) not preserved

v2.8.8

Fixed

• #​2977 - Handle projects not using kotlin-reflect #​2977

v2.8.7

Added

• #​2944 - Introducing springdoc-openapi-bom project
• #​2948 - Customize Servers via application.yml
• #​2963 - Set default content type for problem details object to application/problem+jso
• #​2971 - List of value classes in Kotlin

Changed

• Upgrade swagger-ui to v5.21.0
• Upgrade swagger-core to 2.2.30
• Upgrade spring-boot to version 3.4.5
• Upgrade spring-security-oauth2-authorization-server to version 1.4.3

Fixed

• #​2947 - Unexpected warning "Appended trailing slash to static resource location"
• #​2960 - NPE when customizing group's open-api without specifying any schema
• #​2969 - fix path to register resource handler to work SwaggerIndexPageTransformer
  considering /webjar path prefix
• #​2964 - Cannot add custom description and example for java.time.Duration since v2.8.6
• #​2972 - @​Header(schema = @​Schema(type = "string")) generates empty or broken schema in
  OpenAPI output since 2.8.0
• #​2976, #​2967 - Build Failure due to Private Inner Class.

v2.8.6

Added

• #​2909 - Check both SerDe BeanPropertyDefinition for @​JsonUnwrapped/@​Schema
• #​2927 - Bail sealed class subtype introspection on Schema
• #​2917 - Add Future to ignored response wrappers
• #​2938 - Add out of the box support for LocalTime, YearMonth, MonthDay

Changed

• Upgrade swagger-ui to v5.20.1
• Upgrade swagger-core to 2.2.29
• Upgrade spring-cloud-function to 4.2.2
• Upgrade spring-boot to version 3.4.4

Fixed

• #​2928 - Add missing builder methods in SchemaBuilder
• #​2905 - ModelResolver.enumAsRef = true result in invalid openapi with actuator using
  enum param
• #​2939 - Duplicate ModelConverter registration with Spring Boot DevTools
• #​2941 - SpringBoot native fails /v3/api-docs when using a Map as an http entity field

v2.8.5

Added

• #​2696 - Do not require JsonSubType annotation for sealed classes
• #​2898 - add needed runtime reflection hints for native image
• #​2891 - Refactor trimIndent Method
• #​2931 - OpenAPIService serverBaseUrl is not thread safe
• #​2933 - Wrong schema generation with PagedModel generated VIA_DTO and wrapped in
  ResponseEntity

Changed

• Upgrade swagger-ui to v5.18.3

Fixed

• #​2902 - Schema replaced by String when using @​ApiResponse with RepresentationModel (
  Hateoas links)
• #​2876 - Restentpoints with same name get mix up
• #​2895 - Only filter out actuator endpoints with double asterisks.
• #​2894 - respect @​JsonUnwrapped & @​Schema on props not fields only
• #​2881 - fix defaultValue when using @​PageableDefault together with
  one-indexed-parameters
• #​2888 - Provide a better consistency for parameters and responses order.

v2.8.4

Added

• #​2873 - Improve performance of getGenericMapResponse
• #​2836 - Provide option to set allowed locales
• 2862 - Align Swagger-UI Prefix Path with Swagger-WebMvc Behavior

Changed

• Upgrade spring-boot to 3.4.2
• Upgrade spring-cloud-function to 4.2.1
• Upgrade swagger-core to 2.2.28

Fixed

• #​2870 - Springdoc 2.8.x + Spring Boot 3.4.1 breaks native image support
• #​2869 - Exception logged when generating schema for delete method of Spring Data
  repository.
• #​2856 - @​JsonUnwrapped is ignored in new version of lib.
• #​2852 - @​Schema(types = "xxx") does not work for multipart param with enabled
  springdoc.default-support-form-data config option.

v2.8.3

Added

• #​2851 - Refine condition, for ignoring types when using PolymorphicModelConverter

v2.8.2

Added

• #​2849 - Provide better compatibility for projects migrating from OAS 3.0 to OAS 3.1

Fixed

• #​2846 - ClassCastException with spring-data-rest and openapi version 3.1 bug
• #​2844 - PageableObject and SortObject are called Pageablenull and Sortnull

v2.8.1

Added

• #​3122 – Add log notifications when SpringDocs / Scalar are enabled by default
• #​3123 – Add support for serving static resources
• #​3151 – Add @Order to ApplicationReadyEvent listener
• #​3158 – Add support for API groups in Scalar
• #​3187 – Add Scalar WebMVC and WebFlux support
• #​3185 – Disable creation of blank GitHub issues (GitHub settings & workflow)
• #​3186 – Decouple Web Server APIs following Spring Boot modularization
• #​3131 - Improve warning messages when documentation is explicitly enabled
• #​3183 - Remove unused operations consumer from route builder methods
• #​3141 - Change handling so useReturnTypeSchema is evaluated at HTTP status code level instead of method level

Changed

• Upgrade Spring Boot to version 3.5.9
• Upgrade swagger-core to version 2.2.41
• Upgrade swagger-ui to version 5.31.0
• Upgrade Scalar to version 0.4.3

Fixed

• #​3133 – Fix regression where content type from Swagger @RequestBody did not take precedence
• #​3146 – Fix WebJar resource handler mappings for Swagger UI resources
• #​3168 – Support @Schema annotations on Kotlin value classes
• #​3178 – Fix regression when generating documentation for Kotlin LinkedHashSet
• #​3170 – Fix warnings when setting title and description in application.yml
• #​3187 – Add scalar scalar-webmvc and scalar-webflux support

v2.8.0

Added

• #​2790 - Moving to OpenAPI 3.1 as the default implementation for springdoc-openapi
• #​2817 - Obey annotations when flattening ParameterObject fields
• #​2826 - Make it possible to mark parameters with @​RequestParam annotation to be sent in
  form instead of query.
• #​2822 - Support returning null in ParameterCustomizer
• #​2830 - Add support for deprecated fields.
• #​2780 - Add Security Schema by AutoConfigure

Changed

• Upgrade spring-boot to 3.4.1
• Upgrade spring-cloud-function to 4.2.0
• Upgrade swagger-core to 2.2.27

Fixed

• #​2804 - Stable release 2.7.0 depends on Spring Cloud Milestone 4.2.0-M1
• #​2828 - Required a bean of type '
  org.springframework.data.rest.webmvc.mapping.Associations' that could not be found.
• #​2823 - Capturing pattern in identical paths only renders the path element of one method
• #​2817 - Automatically add required if a field is @​notNull or @​NotBlank.
• #​2814 - An unresolvable circular reference with
  management.endpoint.gateway.enabled=true.
• #​2798 - Object schema generated for Unit Kotlin type.
• #​2797 - Removing operationId via customizer does not work anymore.
• #​2833 - Resolve infinite recursion and add example test with OpenAPI v3.1
• #​2827 - Ignoring @​Parameter(required = false)

v2.7.0

Added

• #​2777 - Add SortAsQueryParam annotation
• #​2786 - No static resource swagger-ui/index.html error after migration to 2.7.0-RC1

Changed

• Upgrade spring-boot to 3.4.0
• Upgrade swagger-ui to 5.18.2
• Upgrade spring-security-oauth2-authorization-server to 1.4.0

v2.6.0

Compare Source

Added

• #​2561 - NPE occurs when outputting an OpenAPI document since 2.5.0
• #​2579 - Add support for leading tab characters with trim-kotlin-indent.
• #​2589 - Pass HttpRequest to ServerBaseUrlCustomizer
• #​2596, #​2600 - consumes and produces calculation. Fixes
• #​2625, #​2626 - Replace Page schema with PagedModel when pageSerializationMode is set to
  VIA_DTO
• #​2627 - Ensure compatibility with previous version of spring data
• #​2576 - GroupedApi orders by displayName instead of name.
• #​2584 - Dynamically define ApiGroups does not work.
• #​2595 - Spring security support of @​RegisteredOAuth2AuthorizedClient

Changed

• Upgrade spring-boot to 3.3.0
• Upgrade swagger-core to 2.2.22
• Upgrade swagger-ui to 5.17.14
• Upgrade spring-cloud-function to 4.1.2
• Upgrade spring-security-oauth2-authorization-server to 1.3.0

Fixed

• #​2577 - Fix missing exception response types in OpenAPI spec
• #​2591 - When an entity class contains fields of Class<?> type, an infinite loop.
• #​2603 - PolymorphicModelConverter only handles direct subtypes and misses indirect.
• #​2606 - Spring Authorization Server Metadata Endpoint not compatible.
• #​2621 - Content-type for POST endpoints with multipart/form-data does not work since
  v2.4.0.
• #​2622 - Kotlin enums are always marked as required if used in Java controllers.
• #​2601 - Multiple Superclasses Are Not Mapped To Multiple allOf If Used In Different
  Services.
• #​2597 - Polymorphic fields on polymorphic parents don't get correct oneOf docs
  generated.

v2.5.0

Compare Source

Added

• #​2318 - Add Info to GroupedOpenAPI properties
• #​2554 - Remove duplicate words from comments
• #​2418 - Improve support for externalizing strings in generated openapi
• #​2535 - Add 'springdoc.trim-kotlin-indent' property to handle Kotlin multiline string
  indentation

Changed

• Upgrade spring-boot to 3.2.4
• Upgrade swagger-core to 2.2.21
• Upgrade swagger-ui to 5.13.0

Fixed

• #​2525 - Inherited Methods Not Included in Swagger Documentation with @​RouterOperation in
  Spring Boot WebFlux Application
• #​2526 - SpringDoc bean naming conflict error with GraphQL Spring boot starter
• #​2540 - Fix typo in SpringRepositoryRestResourceProvider.java
• #​2549 - Fix README.md

v2.4.0

Compare Source

Added

• #​2443 - Respect schema annotations when using spring mvc with kotlin
• #​2492, #​2488 - Support dynamic evaluation of description field in the RequestBody
• #​2510 - Option to disable root api-docs path when using groups

Changed

• Upgrade spring-boot to 3.2.3
• Upgrade swagger-core to 2.2.20
• Upgrade swagger-ui to 5.11.8

Fixed

• #​2453 - Fix CODE_OF_CONDUCT.md links
• #​2454 - Fix typo in SwaggerWelcomeWebMvc
• #​2507 - Fix typo in Constants
• #​2472 - Update JavadocPropertyCustomizer.java
• #​2495 - Fix broken links in README and CONTRIBUTING
• #​2501 - bug fix when "exported" is set to false in RestResource annotation
• #​2447 - Serialization to openapi of org.springframework.data.domain.Sort is not done
  correctly
• #​2449 - Extensions in subobjects of OpenAPI no longer work
• #​2461 - Springdoc OpenApi Annotations @​ExtensionProperty Not Evaluating Properties from
  application.yml
• #​2469 - Pom contains invalid organizationUrl
• #​2518 - Duplicate GroupConfigs in SpringDocConfigProperties
• #​2506 - Springdoc breaks (Unexpected value: TRACE) when a
  spring-cloud-starter-gateway-mvc universal gateway is configured.
• #​2519 - Request parameter parsing error after using @​NotBlank from type interface field
• #​2516 - Spring Data REST fails when setting version to openapi_3_1
• #​2509 - ArrayIndexOutOfBoundsException in SwaggerUiConfigParameters
• #​2484 - JavaDoc integration not working with SnakeCaseStrategy property naming
• #​2483 - Controller advice documents ApiResponse on every operation, even if the
  operation does not annotate the exception to be thrown
• #​2477 - buildApiResponses ignores produced ContentType in case of many @​Operation

v2.3.0

Compare Source

Added

• #​2340 - Add support OIDC with Spring Authorization Server
• #​2345 - Support Schema added in OpenAPI Specification v3.1
• #​2387 - Support get javadoc description from getter method
• #​2404 - Update condition to register links schema customizer
• #​2359 - Update condition to register links schema customizer
• #​2348 - Enhance resource path processing
• #​2438, #​2315 - Support for @​JsonProperty with Javadoc Change in springdoc-openapi

Changed

• Upgrade spring-boot to 3.2.0
• Upgrade swagger-core to 2.2.19
• Upgrade swagger-ui to 5.10.3

Fixed

• #​2366 - Fix the failed test due to hardcoded file separators
• #​2370, #​2371 - No empty description for polymorphic subtypes
• #​2373 - SchemaProperty.array Schema is ignored in /api-docs or api-docs.yaml
• #​2366 - Refactoring AbstractSwaggerResourceResolver.findWebJarResourcePath
• #​2320 - javadoc for class attribute ignored when in EntityModel.
• #​2347 - Not working if a property of entity contains generic parameters.
• #​2399 - SpringdocRouteBuilder.onError is overriding last route defined.
• #​2426 - StackOverflowError when using @​ParameterObject on groovy class.